home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat2 / socket.0 < prev    next >
Text File  |  1996-09-01  |  7KB  |  133 lines
  1.  
  2. SOCKET(2)                  UNIX Programmer's Manual                  SOCKET(2)
  3.  
  4. NNAAMMEE
  5.      ssoocckkeett - create an endpoint for communication
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  9.      ##iinncclluuddee <<ssyyss//ssoocckkeett..hh>>
  10.  
  11.      _i_n_t
  12.      ssoocckkeett(_i_n_t _d_o_m_a_i_n, _i_n_t _t_y_p_e, _i_n_t _p_r_o_t_o_c_o_l)
  13.  
  14. DDEESSCCRRIIPPTTIIOONN
  15.      SSoocckkeett() creates an endpoint for communication and returns a descriptor.
  16.  
  17.      The _d_o_m_a_i_n parameter specifies a communications domain within which com-
  18.      munication will take place; this selects the protocol family which should
  19.      be used.  These families are defined in the include file <_s_y_s_/_s_o_c_k_e_t_._h>.
  20.      The currently understood formats are
  21.  
  22.            AF_UNIX         (UNIX internal protocols),
  23.            AF_INET         (ARPA Internet protocols),
  24.            AF_ISO          (ISO protocols),
  25.            AF_NS           (Xerox Network Systems protocols), and
  26.            AF_IMPLINK      (IMP host at IMP link layer).
  27.  
  28.      The socket has the indicated _t_y_p_e, which specifies the semantics of com-
  29.      munication.  Currently defined types are:
  30.  
  31.            SOCK_STREAM
  32.            SOCK_DGRAM
  33.            SOCK_RAW
  34.            SOCK_SEQPACKET
  35.            SOCK_RDM
  36.  
  37.      A SOCK_STREAM type provides sequenced, reliable, two-way connection based
  38.      byte streams.  An out-of-band data transmission mechanism may be support-
  39.      ed.  A SOCK_DGRAM socket supports datagrams (connectionless, unreliable
  40.      messages of a fixed (typically small) maximum length).  A SOCK_SEQPACKET
  41.      socket may provide a sequenced, reliable, two-way connection-based data
  42.      transmission path for datagrams of fixed maximum length; a consumer may
  43.      be required to read an entire packet with each read system call.  This
  44.      facility is protocol specific, and presently implemented only for PF_NS.
  45.      SOCK_RAW sockets provide access to internal network protocols and inter-
  46.      faces.  The types SOCK_RAW, which is available only to the super-user,
  47.      and SOCK_RDM, which is planned, but not yet implemented, are not de-
  48.      scribed here.
  49.  
  50.      The _p_r_o_t_o_c_o_l specifies a particular protocol to be used with the socket.
  51.      Normally only a single protocol exists to support a particular socket
  52.      type within a given protocol family.  However, it is possible that many
  53.      protocols may exist, in which case a particular protocol must be speci-
  54.      fied in this manner.  The protocol number to use is particular to the
  55.      communication domain in which communication is to take place; see
  56.      protocols(5).
  57.  
  58.      Sockets of type SOCK_STREAM are full-duplex byte streams, similar to
  59.      pipes.  A stream socket must be in a _c_o_n_n_e_c_t_e_d state before any data may
  60.      be sent or received on it.  A connection to another socket is created
  61.      with a connect(2) call.  Once connected, data may be transferred using
  62.      read(2) and write(2) calls or some variant of the send(2) and recv(2)
  63.      calls.  When a session has been completed a close(2) may be performed.
  64.      Out-of-band data may also be transmitted as described in send(2) and re-
  65.      ceived as described in recv(2).
  66.  
  67.      The communications protocols used to implement a SOCK_STREAM insure that
  68.      data is not lost or duplicated.  If a piece of data for which the peer
  69.      protocol has buffer space cannot be successfully transmitted within a
  70.      reasonable length of time, then the connection is considered broken and
  71.      calls will indicate an error with -1 returns and with ETIMEDOUT as the
  72.      specific code in the global variable _e_r_r_n_o. The protocols optionally keep
  73.      sockets ``warm'' by forcing transmissions roughly every minute in the ab-
  74.      sence of other activity.  An error is then indicated if no response can
  75.      be elicited on an otherwise idle connection for a extended period (e.g. 5
  76.      minutes).  A SIGPIPE signal is raised if a process sends on a broken
  77.      stream; this causes naive processes, which do not handle the signal, to
  78.      exit.
  79.  
  80.      SOCK_SEQPACKET sockets employ the same system calls as SOCK_STREAM sock-
  81.      ets.  The only difference is that read(2) calls will return only the
  82.      amount of data requested, and any remaining in the arriving packet will
  83.      be discarded.
  84.  
  85.      SOCK_DGRAM and SOCK_RAW sockets allow sending of datagrams to correspon-
  86.      dents named in send(2) calls.  Datagrams are generally received with
  87.      recvfrom(2),  which returns the next datagram with its return address.
  88.  
  89.      An fcntl(2) call can be used to specify a process group to receive a
  90.      SIGURG signal when the out-of-band data arrives.  It may also enable non-
  91.      blocking I/O and asynchronous notification of I/O events via SIGIO.
  92.  
  93.      The operation of sockets is controlled by socket level _o_p_t_i_o_n_s. These op-
  94.      tions are defined in the file <_s_y_s_/_s_o_c_k_e_t_._h>. Setsockopt(2) and getsock-
  95.      opt(2) are used to set and get options, respectively.
  96.  
  97. RREETTUURRNN VVAALLUUEESS
  98.      A -1 is returned if an error occurs, otherwise the return value is a de-
  99.      scriptor referencing the socket.
  100.  
  101. EERRRROORRSS
  102.      The ssoocckkeett() call fails if:
  103.  
  104.      [EPROTONOSUPPORT]
  105.                    The protocol type or the specified protocol is not support-
  106.                    ed within this domain.
  107.  
  108.      [EMFILE]      The per-process descriptor table is full.
  109.  
  110.      [ENFILE]      The system file table is full.
  111.  
  112.      [EACCESS]     Permission to create a socket of the specified type and/or
  113.                    protocol is denied.
  114.  
  115.      [ENOBUFS]     Insufficient buffer space is available.  The socket cannot
  116.                    be created until sufficient resources are freed.
  117.  
  118. SSEEEE AALLSSOO
  119.      accept(2),  bind(2),  connect(2),  getprotoent(3),  getsockname(2),
  120.      getsockopt(2),  ioctl(2),  listen(2),  read(2),  recv(2),  select(2),
  121.      send(2),  shutdown(2),  socketpair(2),  write(2)
  122.  
  123.      _A_n _I_n_t_r_o_d_u_c_t_o_r_y _4_._3 _B_S_D _I_n_t_e_r_p_r_o_c_e_s_s _C_o_m_m_u_n_i_c_a_t_i_o_n _T_u_t_o_r_i_a_l, reprinted in
  124.      UNIX Programmer's Supplementary Documents Volume 1.
  125.  
  126.      _B_S_D _I_n_t_e_r_p_r_o_c_e_s_s _C_o_m_m_u_n_i_c_a_t_i_o_n _T_u_t_o_r_i_a_l, reprinted in UNIX Programmer's
  127.      Supplementary Documents Volume 1.
  128.  
  129. HHIISSTTOORRYY
  130.      The ssoocckkeett() function call appeared in 4.2BSD.
  131.  
  132. 4.2 Berkeley Distribution        June 4, 1993                                2
  133.